extends DirectoryResource
Dav accessible
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| moduleStatus | ModuleStatus | Return the ModuleStatus (ie learning record) for the current user for this module, if there is one. | |
| currentPage | String | Dav accessible | |
| moduleStatusFields | Map | Dav accessible | |
| submittedDate | Date | Dav accessible | |
| currentPageNum | Integer | Dav accessible Get the zero-indexed page number of the current page for this user | |
| percentComplete | Integer | Dav accessible | |
| score | Integer | Dav accessible The final module score as a percentage. Calculated when the module is completed as the averge of all quiz scores | |
| brief | String | Dav accessible | |
| rawThumb | String | ||
| thumb | String | Dav accessible | |
| highlights | String | Dav accessible | |
| learningTimeMins | int | Dav accessible | |
| instructorType | String | Dav accessible | |
| expiryFrequency | Frequency | ||
| expiryMultiples | Integer | ||
| moduleCompleteActions | List | The list of things to do when the module is completed, such as generate certificates and award rewards. Reads from completeActions.xml | |
| completionMessage | String | ||
| unmetPrerequisites | List | Returns a plain list of modules that need to be completed before this module can be started | |
| level | Integer | Dav accessible | |
| order | Integer | Dav accessible | |
| currentLevel | int | Dav accessible What level the current user is up to. A user is within a level if they have completed all pre-requisites for it, but has not completed it. | |
| numModulePages | int | ||
| modulePages | ResourceList | ||
| rewards | List | Gets the configured rewards for this module | |
| certificates | List | Gets the configured certificates for the module | |
| configuredCertificates | List | ||
| cpdPoints | Map | Get a map of CPD points as defined on certificates, keyed on the name of the certificate | |
| awardedCpdPoints | Map | Returns a map of awarded cpd points, keyed on the certificate name If multiple CPD awards have been made for a certificate they will be summed | |
| firstAwardedCpdPoints | Double | Just returns the first value from getAwardedCpdPoints or null if none are present. This is for the usual case where there is only one certificate being awarded | |
| certificateHrefs | List | Dav accessible Returns a list of hrefs to all certificates which the current user is entitled to for this module. These may be pre-generated, in which case the href is to the generated file. Or if they are not currently generated the href is to a link which will generate the certificate | |
| certificateFiles | List | Returns the list of certificate files (ie PDFs) for the current user for this folder. These can be used to generate links | |
| programCode | String | ||
| courseCode | String | ||
| orgModuleStats | OrgModulesStats | ||
| nextModule | ModuleFolder | Returns the next module in this course, or null if there is no more | |
| finalScorePerc | Integer | Returns the score for the current user for this module as a percentage. The score is assigned when the module is completed. | |
| numberCompletions | long | ||
| numberStarted | long | ||
| numberIncomplete | long | ||
| moduleCalEvents | List | ||
| upcomingModuleCalEvents | List | ||
| nextIltDate | Date |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| quizAttempts ( quizName ) | List | Get the date/times of quiz attempts for the given quiz page. Use this to find out how many quiz attempts there have been for this user of the given quiz | |
| getQuizInfo ( quiz ) | QuizInfo |
Hide comments
